logo
Documentation Powered by Redocly

RecovR Production (0.0.1)

Download OpenAPI specification:Download

RecovR Production.

Beacon

Get Beacon through Zone/Beacons

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Zone/Beacons

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Zone/Beacons by network alias

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Zone/Beacons

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Zone/Beacons

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Zone/Beacons

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Floor/Zones/Beacons

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Floor/Zones/Beacons

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Floor/Zones/Beacons by network alias

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Floor/Zones/Beacons

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Floor/Zones/Beacons

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Floor/Zones/Beacons

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Location/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Zones/Beacons by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Location/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Location/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Location/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Location/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Beacons by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Location/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Location/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Location/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Floors/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Location/Floors/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Location/Floors/Zones/Beacons by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Location/Floors/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Location/Floors/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Location/Floors/Zones/Beacons

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Company/Locations/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Zones/Beacons by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Company/Locations/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Company/Locations/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Company/Locations/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Company/Locations/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Beacons by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Company/Locations/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Company/Locations/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Company/Locations/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Floors/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Company/Locations/Floors/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Locations/Floors/Zones/Beacons by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Company/Locations/Floors/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Company/Locations/Floors/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Company/Locations/Floors/Zones/Beacons

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Beacons

path Parameters
companyId
required
string
beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Beacon through Company/Beacons

path Parameters
companyId
required
string
beaconId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Beacon through Company/Beacons by network alias

path Parameters
companyId
required
string
beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Beacon through Company/Beacons

path Parameters
companyId
required
string
beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Beacon through Company/Beacons

path Parameters
companyId
required
string
beaconId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Beacon through Company/Beacons

path Parameters
companyId
required
string
beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Beacon device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Beacon

path Parameters
beaconId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Zone

A defined geographical region. Could be indoors or outdoors.

Get Zone through Floor/Zones

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Zone through Floor/Zones

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Floor/Zones by network alias

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Zone through Floor/Zones

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Zone through Floor/Zones

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Zone through Floor/Zones

path Parameters
floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Location/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Zone through Location/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Location/Zones by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Zone through Location/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Zone through Location/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Zone through Location/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Location/Floors/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Zone through Location/Floors/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Location/Floors/Zones by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Zone through Location/Floors/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Zone through Location/Floors/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Zone through Location/Floors/Zones

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Company/Locations/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Zone through Company/Locations/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Company/Locations/Zones by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Zone through Company/Locations/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Zone through Company/Locations/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Zone through Company/Locations/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Company/Locations/Floors/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Zone through Company/Locations/Floors/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Zone through Company/Locations/Floors/Zones by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Zone through Company/Locations/Floors/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Zone through Company/Locations/Floors/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Zone through Company/Locations/Floors/Zones

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Zone device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Zone

path Parameters
zoneId
required
string

A defined geographical region. Could be indoors or outdoors.

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Floor

Get Floor through Location/Floors

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Floor through Location/Floors

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Floor through Location/Floors by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Floor through Location/Floors

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Floor through Location/Floors

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Floor through Location/Floors

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Floor through Company/Locations/Floors

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Floor through Company/Locations/Floors

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Floor through Company/Locations/Floors by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Floor through Company/Locations/Floors

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Floor through Company/Locations/Floors

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Floor through Company/Locations/Floors

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Floor device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Floor

path Parameters
floorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Locator

Get Locator through Vehicle/Locator

path Parameters
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Vehicle/Locator

path Parameters
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Vehicle/Locator by network alias

path Parameters
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Vehicle/Locator

path Parameters
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Vehicle/Locator

path Parameters
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Vehicle/Locator

path Parameters
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Case/Vehicle/Locator

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Case/Vehicle/Locator

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Case/Vehicle/Locator by network alias

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Case/Vehicle/Locator

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Case/Vehicle/Locator

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Case/Vehicle/Locator

path Parameters
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Vehicles/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Location/Vehicles/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Vehicles/Locator by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Location/Vehicles/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Location/Vehicles/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Location/Vehicles/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Locators

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Location/Locators

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Locators by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Location/Locators

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Location/Locators

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Location/Locators

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Cases/Vehicle/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Location/Cases/Vehicle/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Location/Cases/Vehicle/Locator by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Location/Cases/Vehicle/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Location/Cases/Vehicle/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Location/Cases/Vehicle/Locator

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Vehicles/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Locations/Vehicles/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Vehicles/Locator by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Locations/Vehicles/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Locations/Vehicles/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Locations/Vehicles/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Locators

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Locations/Locators

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Locators by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Locations/Locators

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Locations/Locators

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Locations/Locators

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Cases/Vehicle/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Locations/Cases/Vehicle/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locations/Cases/Vehicle/Locator by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Locations/Cases/Vehicle/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Locations/Cases/Vehicle/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Locations/Cases/Vehicle/Locator

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Vehicles/Locator

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Vehicles/Locator

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Vehicles/Locator by network alias

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Vehicles/Locator

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Vehicles/Locator

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Vehicles/Locator

path Parameters
companyId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locators

path Parameters
companyId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Locators

path Parameters
companyId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Locators by network alias

path Parameters
companyId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Locators

path Parameters
companyId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Locators

path Parameters
companyId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Locators

path Parameters
companyId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Cases/Vehicle/Locator

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Locator through Company/Cases/Vehicle/Locator

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Locator through Company/Cases/Vehicle/Locator by network alias

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Locator through Company/Cases/Vehicle/Locator

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Locator through Company/Cases/Vehicle/Locator

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Locator through Company/Cases/Vehicle/Locator

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Locator device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Locator

path Parameters
locatorId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Vehicle

Get Vehicle through Case/Vehicle

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Case/Vehicle

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Case/Vehicle by network alias

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Case/Vehicle

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Case/Vehicle

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Case/Vehicle

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Location/Vehicles

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Location/Vehicles

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Location/Vehicles by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Location/Vehicles

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Location/Vehicles

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Location/Vehicles

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Location/Cases/Vehicle

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Location/Cases/Vehicle

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Location/Cases/Vehicle by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Location/Cases/Vehicle

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Location/Cases/Vehicle

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Location/Cases/Vehicle

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Locations/Vehicles

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Company/Locations/Vehicles

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Locations/Vehicles by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Company/Locations/Vehicles

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Company/Locations/Vehicles

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Company/Locations/Vehicles

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Locations/Cases/Vehicle

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Company/Locations/Cases/Vehicle

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Locations/Cases/Vehicle by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Company/Locations/Cases/Vehicle

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Company/Locations/Cases/Vehicle

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Company/Locations/Cases/Vehicle

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Vehicles

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Company/Vehicles

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Vehicles by network alias

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Company/Vehicles

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Company/Vehicles

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Company/Vehicles

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Cases/Vehicle

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Vehicle through Company/Cases/Vehicle

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Vehicle through Company/Cases/Vehicle by network alias

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Vehicle through Company/Cases/Vehicle

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Vehicle through Company/Cases/Vehicle

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Vehicle through Company/Cases/Vehicle

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Vehicle device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Vehicle

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Sale

Get Sale through Location/Sales

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Sale through Location/Sales

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Sale through Location/Sales by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Sale through Location/Sales

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Sale through Location/Sales

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Sale through Location/Sales

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Sale through Company/Locations/Sales

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Sale through Company/Locations/Sales

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Sale through Company/Locations/Sales by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Sale through Company/Locations/Sales

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Sale through Company/Locations/Sales

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Sale through Company/Locations/Sales

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Sale through Company/Sales

path Parameters
companyId
required
string
saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Sale through Company/Sales

path Parameters
companyId
required
string
saleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Sale through Company/Sales by network alias

path Parameters
companyId
required
string
saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Sale through Company/Sales

path Parameters
companyId
required
string
saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Sale through Company/Sales

path Parameters
companyId
required
string
saleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Sale through Company/Sales

path Parameters
companyId
required
string
saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Sale device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Sale

path Parameters
saleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Case

Get Case through Location/Cases

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Case through Location/Cases

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Case through Location/Cases by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Case through Location/Cases

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Case through Location/Cases

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Case through Location/Cases

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Case through Company/Locations/Cases

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Case through Company/Locations/Cases

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Case through Company/Locations/Cases by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Case through Company/Locations/Cases

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Case through Company/Locations/Cases

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Case through Company/Locations/Cases

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Case through Company/Cases

path Parameters
companyId
required
string
caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Case through Company/Cases

path Parameters
companyId
required
string
caseId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Case through Company/Cases by network alias

path Parameters
companyId
required
string
caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Case through Company/Cases

path Parameters
companyId
required
string
caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Case through Company/Cases

path Parameters
companyId
required
string
caseId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Case through Company/Cases

path Parameters
companyId
required
string
caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Case device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Case

path Parameters
caseId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Location

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Get Location through Company/Locations

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Location through Company/Locations

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Location through Company/Locations by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Location through Company/Locations

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Location through Company/Locations

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Location through Company/Locations

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Location device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Location

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Company

Create new Company device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Company

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Bill

Get Bill through Location/Bills

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Bill through Location/Bills

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Bill through Location/Bills by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Bill through Location/Bills

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Bill through Location/Bills

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Bill through Location/Bills

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Bill through Company/Locations/Bills

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Bill through Company/Locations/Bills

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Bill through Company/Locations/Bills by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Bill through Company/Locations/Bills

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Bill through Company/Locations/Bills

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Bill through Company/Locations/Bills

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Bill through Company/Bills

path Parameters
companyId
required
string
billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Bill through Company/Bills

path Parameters
companyId
required
string
billId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Bill through Company/Bills by network alias

path Parameters
companyId
required
string
billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Bill through Company/Bills

path Parameters
companyId
required
string
billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Bill through Company/Bills

path Parameters
companyId
required
string
billId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Bill through Company/Bills

path Parameters
companyId
required
string
billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Bill device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Bill

path Parameters
billId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

CompanyContract

Get CompanyContract through Company/CompanyContracts

path Parameters
companyId
required
string
companyContractId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for CompanyContract through Company/CompanyContracts

path Parameters
companyId
required
string
companyContractId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get CompanyContract through Company/CompanyContracts by network alias

path Parameters
companyId
required
string
companyContractId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of CompanyContract through Company/CompanyContracts

path Parameters
companyId
required
string
companyContractId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for CompanyContract through Company/CompanyContracts

path Parameters
companyId
required
string
companyContractId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all CompanyContract through Company/CompanyContracts

path Parameters
companyId
required
string
companyContractId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new CompanyContract device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete CompanyContract

path Parameters
companyContractId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Product

Get Product through Location/Products

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Product through Location/Products

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Product through Location/Products by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Product through Location/Products

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Product through Location/Products

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Product through Location/Products

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Product through Company/Locations/Products

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Product through Company/Locations/Products

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Product through Company/Locations/Products by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Product through Company/Locations/Products

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Product through Company/Locations/Products

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Product through Company/Locations/Products

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Product through Company/Products

path Parameters
companyId
required
string
productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Product through Company/Products

path Parameters
companyId
required
string
productId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Product through Company/Products by network alias

path Parameters
companyId
required
string
productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Product through Company/Products

path Parameters
companyId
required
string
productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Product through Company/Products

path Parameters
companyId
required
string
productId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Product through Company/Products

path Parameters
companyId
required
string
productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Product device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Product

path Parameters
productId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Customer-contract

Get Customer-contract through Location/CustomerContracts

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Customer-contract through Location/CustomerContracts

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Customer-contract through Location/CustomerContracts by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Customer-contract through Location/CustomerContracts

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Customer-contract through Location/CustomerContracts

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Customer-contract through Location/CustomerContracts

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Customer-contract through Company/Locations/CustomerContracts

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Customer-contract through Company/Locations/CustomerContracts

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Customer-contract through Company/Locations/CustomerContracts by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Customer-contract through Company/Locations/CustomerContracts

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Customer-contract through Company/Locations/CustomerContracts

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Customer-contract through Company/Locations/CustomerContracts

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Customer-contract through Company/CustomerContracts

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Customer-contract through Company/CustomerContracts

path Parameters
companyId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Customer-contract through Company/CustomerContracts by network alias

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Customer-contract through Company/CustomerContracts

path Parameters
companyId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Customer-contract through Company/CustomerContracts

path Parameters
companyId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Customer-contract through Company/CustomerContracts

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Customer-contract device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Customer-contract

path Parameters
customer-contractId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Payment

Get Payment through Location/Bills/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Location/Bills/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Location/Bills/Payments by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Location/Bills/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Location/Bills/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Location/Bills/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Location/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Location/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Location/Payments by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Location/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Location/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Location/Payments

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Locations/Bills/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Company/Locations/Bills/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Locations/Bills/Payments by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Company/Locations/Bills/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Company/Locations/Bills/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Company/Locations/Bills/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Locations/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Company/Locations/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Locations/Payments by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Company/Locations/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Company/Locations/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Company/Locations/Payments

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Bills/Payments

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Company/Bills/Payments

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Bills/Payments by network alias

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Company/Bills/Payments

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Company/Bills/Payments

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Company/Bills/Payments

path Parameters
companyId
required
string
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Payments

path Parameters
companyId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Company/Payments

path Parameters
companyId
required
string
paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Company/Payments by network alias

path Parameters
companyId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Company/Payments

path Parameters
companyId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Company/Payments

path Parameters
companyId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Company/Payments

path Parameters
companyId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Bill/Payments

path Parameters
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Payment through Bill/Payments

path Parameters
billId
required
string
paymentId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Payment through Bill/Payments by network alias

path Parameters
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Payment through Bill/Payments

path Parameters
billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Payment through Bill/Payments

path Parameters
billId
required
string
paymentId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Payment through Bill/Payments

path Parameters
billId
required
string
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Payment device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Payment

path Parameters
paymentId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Iosix

Get Iosix through Vehicle/ObdTracker

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Vehicle/ObdTracker

path Parameters
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Vehicle/ObdTracker by network alias

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Vehicle/ObdTracker

path Parameters
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Vehicle/ObdTracker

path Parameters
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Vehicle/ObdTracker

path Parameters
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Case/Vehicle/ObdTracker

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Case/Vehicle/ObdTracker

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Case/Vehicle/ObdTracker by network alias

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Case/Vehicle/ObdTracker

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Case/Vehicle/ObdTracker

path Parameters
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Case/Vehicle/ObdTracker

path Parameters
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/Vehicles/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Location/Vehicles/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/Vehicles/ObdTracker by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Location/Vehicles/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Location/Vehicles/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Location/Vehicles/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/Cases/Vehicle/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Location/Cases/Vehicle/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/Cases/Vehicle/ObdTracker by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Location/Cases/Vehicle/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Location/Cases/Vehicle/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Location/Cases/Vehicle/ObdTracker

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/ObdTrackers

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Location/ObdTrackers

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Location/ObdTrackers by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Location/ObdTrackers

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Location/ObdTrackers

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Location/ObdTrackers

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/Vehicles/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/Locations/Vehicles/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/Vehicles/ObdTracker by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/Locations/Vehicles/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/Locations/Vehicles/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/Locations/Vehicles/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/Locations/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/Cases/Vehicle/ObdTracker by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/Locations/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/Locations/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/Locations/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/ObdTrackers

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/Locations/ObdTrackers

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Locations/ObdTrackers by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/Locations/ObdTrackers

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/Locations/ObdTrackers

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/Locations/ObdTrackers

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Vehicles/ObdTracker

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/Vehicles/ObdTracker

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Vehicles/ObdTracker by network alias

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/Vehicles/ObdTracker

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/Vehicles/ObdTracker

path Parameters
companyId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/Vehicles/ObdTracker

path Parameters
companyId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/Cases/Vehicle/ObdTracker by network alias

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/Cases/Vehicle/ObdTracker

path Parameters
companyId
required
string
caseId
required
string
vehicleId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/ObdTrackers

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Iosix through Company/ObdTrackers

path Parameters
companyId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Iosix through Company/ObdTrackers by network alias

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Iosix through Company/ObdTrackers

path Parameters
companyId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Iosix through Company/ObdTrackers

path Parameters
companyId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Iosix through Company/ObdTrackers

path Parameters
companyId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Iosix device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Iosix

path Parameters
iosixId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}

Addendum

Get Addendum through Location/Bills/Addendum

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Addendum through Location/Bills/Addendum

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Location/Bills/Addendum by network alias

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Addendum through Location/Bills/Addendum

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Addendum through Location/Bills/Addendum

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Addendum through Location/Bills/Addendum

path Parameters
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Company/Locations/Bills/Addendum

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Addendum through Company/Locations/Bills/Addendum

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Company/Locations/Bills/Addendum by network alias

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Addendum through Company/Locations/Bills/Addendum

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Addendum through Company/Locations/Bills/Addendum

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Addendum through Company/Locations/Bills/Addendum

path Parameters
companyId
required
string
locationId
required
string

A location that contains one or more zones with vehicles. Could be a dealership, storage facility, etc.

billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Company/Bills/Addendum

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Addendum through Company/Bills/Addendum

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Company/Bills/Addendum by network alias

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Addendum through Company/Bills/Addendum

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Addendum through Company/Bills/Addendum

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Addendum through Company/Bills/Addendum

path Parameters
companyId
required
string
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Bill/Addendum

path Parameters
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Search for Addendum through Bill/Addendum

path Parameters
billId
required
string
addendumId
required
string
Request Body schema: application/json

Seach query

THIS NEEDS TO BE ADDED
string

These fields will be added soon : )

Responses

Request samples

Content type
application/json
{
  • "THIS NEEDS TO BE ADDED": "string"
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get Addendum through Bill/Addendum by network alias

path Parameters
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Get history of Addendum through Bill/Addendum

path Parameters
billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Get events list for Addendum through Bill/Addendum

path Parameters
billId
required
string
addendumId
required
string
Request Body schema: application/json

Events/History queries

start
timestamp

start time of query

end
timestamp

end time of query

startIndex
string

start index of data (use 100)

perPage
integer

How many data rows per page

attributes
Array of arrays

fields to return in data object (ie. ['$id','$time']

order
Array of arrays

how the data will be ordered (ie. [ 'hourTime', 'ASC' ]

group
Array of arrays

how the data will be groupeed (ie. [ 'hourTime' ]

Responses

Request samples

Content type
application/json
{
  • "start": null,
  • "end": null,
  • "startIndex": "string",
  • "perPage": 0,
  • "attributes": [ ],
  • "order": [ ],
  • "group": [ ]
}

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

List all Addendum through Bill/Addendum

path Parameters
billId
required
string
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "count": 0,
  • "total": 0,
  • "perPage": 0,
  • "startIndex": 0,
  • "search": "string",
  • "items": [
    ]
}

Create new Addendum device

Responses

Response samples

Content type
appliction/json
{
  • "name": "My Device",
  • "id": "0Ml6RFtMiGiy5zu0lpEY86",
  • "blueprintId": "2jcGAvCIyXY9p6RZu8CHE4",
  • "systemId": "48ZXwC058DMBjurH4CpOu7",
  • "projectId": "0oTNqwApTanxLZqVpPjxjc",
  • "networkId": "my-net",
  • "networkAliases": {
    },
  • "purpose": "device",
  • "simulated": false,
  • "metadata": {
    },
  • "created": 1525398286228,
  • "lastModified": 1525402000646
}

Delete Addendum

path Parameters
addendumId
required
string

Responses

Response samples

Content type
appliction/json
{
  • "status": 0,
  • "offset": null,
  • "systemId": "string",
  • "id": "string"
}